fix(theme-classic): avoid rendering empty search box container #7990

drizzlesconsin · 2022-08-23T12:29:15Z

Pre-flight checklist

I have read the Contributing Guidelines on pull requests.
If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

https://stackblitz.com/github/facebook/docusaurus/tree/starter

The search box should not be displayed when the search function is not enabled.

Test Plan

Test links

Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/

Related issues/PRs

facebook-github-bot · 2022-08-23T12:29:20Z

Hi @drizzlesconsin!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

netlify · 2022-08-23T12:32:52Z

✅ [V2]

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`efb479e`
🔍 Latest deploy log	https://app.netlify.com/sites/docusaurus-2/deploys/63066e6c4d391b0007d3c340
😎 Deploy Preview	https://deploy-preview-7990--docusaurus-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

github-actions · 2022-08-23T12:33:38Z

⚡️ Lighthouse report for the deploy preview of this PR

URL	Performance	Accessibility	Best Practices	SEO	PWA	Report
/	🔴 41	🟢 98	🟢 100	🟢 100	🟠 80	Report
/docs/installation	🟠 78	🟢 100	🟢 100	🟢 100	🟢 90	Report

packages/docusaurus-theme-classic/src/theme/Navbar/Search/index.tsx

…x.tsx

packages/docusaurus-theme-classic/src/theme/Navbar/Search/index.tsx

…x.tsx

Josh-Cena

Thank you!

Just pending the CLA

facebook-github-bot · 2022-08-23T14:31:03Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

Josh-Cena

Actually, this doesn't work. If you check locally, the empty container is still rendered. This is because the <SearchBar /> element is always there; it just sometimes returns null (which is not the same as a literal null children). We need a better solution.

drizzlesconsin · 2022-08-24T05:51:27Z

https://github.com/facebook/docusaurus/blob/main/packages/docusaurus-theme-search-algolia/src/theme/SearchBar/index.tsx#L268-L270

That can only be determined by the algolia configuration.

slorber · 2022-08-24T09:27:41Z

packages/docusaurus-theme-classic/src/theme/Navbar/Search/index.tsx

-}: Props): JSX.Element {
+}: Props): JSX.Element | null {
+  const {siteConfig} = useDocusaurusContext();
+  if (!siteConfig.themeConfig?.algolia) {


this will not work for non-official search plugins

em...Let's see if there's another way.

slorber · 2022-08-24T09:31:01Z

The problem is that we are trying to add an implicit search bar by default (ie not configured through themeConfig.navbar.items). When user does not want search, it does not make sense.

What I suggest is that in 3.0 we can do a breaking change:

stop automatically adding an implicit search-bar, force user to be explicit and always provide it as a navbar item
warn if user has no search navbar item but there's a an algolia config provided, eventually try to restore a retrocompatible behavior?
make sure it works nicely on mobile too!

Another possible solution: using CSS .myContainer:has(> *) but it's not supported enough unfortunately

In the future, we should allow search plugin authors to register their own Navbar item components. They would be able to create a type: "my-local-search" instead of overwriting @theme/SearchBar

Do you still want to work on this? (considering you opened a patch-1 branch, and we are looking for a good solution requiring you to invest time, not a quickfix)

Fixing it just for yourself should be possible with swizzling or custom CSS

drizzlesconsin · 2022-08-24T18:28:54Z

Is it possible to use this method here?

children.type() === null

I read:
React component children detect if empty / null before render
Is there any way for Parent to know if Child rendered null?

slorber · 2022-08-25T12:00:14Z

There's no good solution to this problem in React. I don't want to introduce hacky workarounds in our theme when there's a clear elegant solution: be explicit and avoid rendering this parent search component in the first place

drizzlesconsin · 2022-08-25T12:31:26Z

Looks like it can only be hack with CSS.

lex111 · 2022-10-27T20:33:45Z

What about using the named Noop component and then before rendering SearchBar, checking the value of SearchBar.name !== 'Noop'? Maybe is a lesser of an evil?

slorber · 2023-10-08T17:49:33Z

will be fixed in #9385

fix(theme-classic): fix empty searchBox

9ecf329

drizzlesconsin requested review from slorber, lex111 and Josh-Cena as code owners August 23, 2022 12:29

Josh-Cena reviewed Aug 23, 2022

View reviewed changes

packages/docusaurus-theme-classic/src/theme/Navbar/Search/index.tsx Outdated Show resolved Hide resolved

Update packages/docusaurus-theme-classic/src/theme/Navbar/Search/inde…

b7aa3bf

…x.tsx

Josh-Cena reviewed Aug 23, 2022

View reviewed changes

packages/docusaurus-theme-classic/src/theme/Navbar/Search/index.tsx Outdated Show resolved Hide resolved

Josh-Cena and others added 3 commits August 23, 2022 08:43

Update packages/docusaurus-theme-classic/src/theme/Navbar/Search/inde…

1bcfb75

…x.tsx

chore: update NavbarSearch type

87c7c1c

Update theme-classic.d.ts

77a61c3

Josh-Cena changed the title ~~fix(theme-classic): fix empty searchBox~~ fix(theme-classic): avoid rendering empty search box container Aug 23, 2022

Josh-Cena added pr: polish This PR adds a very minor behavior improvement that users will enjoy. to backport This PR is planned to be backported to a stable version of Docusaurus labels Aug 23, 2022

Josh-Cena approved these changes Aug 23, 2022

View reviewed changes

facebook-github-bot added the CLA Signed Signed Facebook CLA label Aug 23, 2022

This makes more sense

ff51a63

Josh-Cena requested changes Aug 24, 2022

View reviewed changes

fix: update judgment condition

31ee0b0

slorber requested changes Aug 24, 2022

View reviewed changes

slorber marked this pull request as draft August 24, 2022 09:31

feat: is child null

efb479e

drizzlesconsin marked this pull request as ready for review August 25, 2022 09:29

slorber marked this pull request as draft August 26, 2022 15:45

slorber mentioned this pull request Apr 13, 2023

Navbar renders a useless SearchBox element when site does not have any search plugin #8889

Closed

7 tasks

slorber linked an issue Apr 13, 2023 that may be closed by this pull request

Navbar renders a useless SearchBox element when site does not have any search plugin #8889

Closed

7 tasks

slorber added this to the 3.0 milestone Sep 25, 2023

slorber mentioned this pull request Oct 8, 2023

fix(theme): avoid rendering empty search container if site has no search plugin #9385

Merged

slorber closed this Oct 8, 2023

slorber removed the to backport This PR is planned to be backported to a stable version of Docusaurus label Nov 10, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(theme-classic): avoid rendering empty search box container #7990

fix(theme-classic): avoid rendering empty search box container #7990

drizzlesconsin commented Aug 23, 2022

facebook-github-bot commented Aug 23, 2022

netlify bot commented Aug 23, 2022 •

edited

Loading

github-actions bot commented Aug 23, 2022 •

edited

Loading

Josh-Cena left a comment

facebook-github-bot commented Aug 23, 2022

Josh-Cena left a comment

drizzlesconsin commented Aug 24, 2022

slorber Aug 24, 2022

drizzlesconsin Aug 24, 2022

slorber commented Aug 24, 2022 •

edited

Loading

drizzlesconsin commented Aug 24, 2022

slorber commented Aug 25, 2022

drizzlesconsin commented Aug 25, 2022

lex111 commented Oct 27, 2022

slorber commented Oct 8, 2023

fix(theme-classic): avoid rendering empty search box container #7990

fix(theme-classic): avoid rendering empty search box container #7990

Conversation

drizzlesconsin commented Aug 23, 2022

Pre-flight checklist

Motivation

Test Plan

Test links

Related issues/PRs

facebook-github-bot commented Aug 23, 2022

Action Required

Process

netlify bot commented Aug 23, 2022 • edited Loading

✅ [V2]

github-actions bot commented Aug 23, 2022 • edited Loading

⚡️ Lighthouse report for the deploy preview of this PR

Josh-Cena left a comment

Choose a reason for hiding this comment

facebook-github-bot commented Aug 23, 2022

Josh-Cena left a comment

Choose a reason for hiding this comment

drizzlesconsin commented Aug 24, 2022

slorber Aug 24, 2022

Choose a reason for hiding this comment

drizzlesconsin Aug 24, 2022

Choose a reason for hiding this comment

slorber commented Aug 24, 2022 • edited Loading

drizzlesconsin commented Aug 24, 2022

slorber commented Aug 25, 2022

drizzlesconsin commented Aug 25, 2022

lex111 commented Oct 27, 2022

slorber commented Oct 8, 2023

netlify bot commented Aug 23, 2022 •

edited

Loading

github-actions bot commented Aug 23, 2022 •

edited

Loading

slorber commented Aug 24, 2022 •

edited

Loading